set-function-name

What is set-function-name?

The `set-function-name` npm package allows developers to dynamically change the name of a function at runtime. This can be particularly useful for debugging purposes or when working with higher-order functions where maintaining a clear and meaningful stack trace is important. The package provides a straightforward and easy-to-use API for renaming functions.

What are set-function-name's main functionalities?

Setting a function's name

This feature allows you to set a new name for an existing function. The code sample demonstrates how to use `set-function-name` to change a function's name from 'originalFunction' to 'newFunctionName'.

const setFunctionName = require('set-function-name');

function originalFunction() {}
console.log(originalFunction.name); // 'originalFunction'

const renamedFunction = setFunctionName(originalFunction, 'newFunctionName');
console.log(renamedFunction.name); // 'newFunctionName'

Other packages similar to set-function-name

function-name

The `function-name` package offers functionality to get or set a function's name. Compared to `set-function-name`, it provides a more comprehensive solution by not only allowing the setting of a function's name but also retrieving it. This can be particularly useful in scenarios where you need to manipulate and inspect function names dynamically.

rename-function

Similar to `set-function-name`, the `rename-function` package allows for the renaming of functions. However, it might offer a different implementation or additional features such as compatibility with more environments or stricter error handling. The choice between `set-function-name` and `rename-function` could come down to specific project requirements or personal preference.

README

set-function-name

Set a function’s name.

Arguments:

• fn: the function
• name: the new name
• loose: Optional. If true, and the name fails to be set, do not throw. Default false.

Returns fn.

Usage

var setFunctionName = require('set-function-name');
var assert = require('assert');

const obj = {
    concise() {},
    arrow: () => {},
    named: function named() {},
    anon: function () {},
};
assert.equal(obj.concise.name, 'concise');
assert.equal(obj.arrow.name, 'arrow');
assert.equal(obj.named.name, 'named');
assert.equal(obj.anon.name, 'anon');

assert.equal(setFunctionName(obj.concise, 'brief'), obj.concise);
assert.equal(setFunctionName(obj.arrow, 'pointy'), obj.arrow);
assert.equal(setFunctionName(obj.named, ''), obj.named);
assert.equal(setFunctionName(obj.anon, 'anonymous'), obj.anon);

assert.equal(obj.concise.name, 'brief');
assert.equal(obj.arrow.name, 'pointy');
assert.equal(obj.named.name, '');
assert.equal(obj.anon.name, 'anonymous');

Changelog

v2.0.2 - 2024-02-19

Commits

• [meta] add types ae747cd
• [Dev Deps] update aud, npmignore, object-inspect, tape 01aafcb
• [Deps] update define-data-property, has-property-descriptors 0ef6338
• [Refactor] use es-errors 0b23e87